home *** CD-ROM | disk | FTP | other *** search
/ PC Active 2009 July/August / PC Active NR.227.iso / Software / Games / windows / Freeciv-2.1.9-win32-gtk2-setup.exe / doc / README.sound < prev    next >
Encoding:
Text File  |  2009-03-25  |  4.2 KB  |  108 lines
  1.  
  2. ===========================================================================
  3.  Sound Support
  4. ===========================================================================
  5.  
  6. The server sends the client a list of primary and secondary sound tags
  7. for certain events. The 'primary' tags are those preferred by the
  8. current modpack. The client does not need to have these sounds. The
  9. 'secondary' tags should refer to standard sounds that all
  10. installations of Freeciv should have.
  11.  
  12. Tags are used to give an easy way to change sounds. A specfile is used
  13. to indicate which tags refer to which sound files. A change of spec
  14. file, given as an option at startup, will change sounds. For example,
  15.  
  16.     civclient --Sound mysounds.spec
  17.  
  18. will read sound files from "mysounds.spec". You will need to download
  19. or copy or link those sounds into whichever directory is mentioned in this 
  20. file first, or edit it to refer to the right files. All references are by 
  21. default relative to the data/ directory. Soundpacks can be downloaded from
  22. the Freeciv website in the tar format. You will either need to unpack them
  23. with eg "tar -xzvf stdsoundsX.tar.gz" or use WinZip (for Windows), and
  24. put the files in the data directory mentioned above.
  25.  
  26. You can get additional soundsets (sound files and a spec file)
  27. from <ftp://ftp.freeciv.org/freeciv/contrib/audio/soundsets>. At this address
  28. you find also extra sound files to change an existing soundset or
  29. create a new one.
  30.  
  31. ================================
  32.  Plugins
  33. ================================
  34.  
  35. The output of the sounds at the client side are done by plugins. The
  36. set of available plugins depend on the librarys found on the host
  37. system. You can choose the plugin the client should use via the
  38. command line:
  39.  
  40.     civclient --Plugin sdl
  41.  
  42. You can choose "none" to mute the client. Freeciv currently supports
  43. the following plugins:
  44.   - dummy (none)
  45.   - SDL with SDL_mixer library (sdl)
  46.  
  47. To add support for a new plugin, change these files (where "whatever"
  48. is the name of the new plugin):
  49.     configure.in            /* add new test */
  50.     acconfig.h            /* add new config metavariable */
  51.     client/audio.c            /* link in new plugin */
  52.     client/Makefile.am        /* add the files below */
  53.     client/audio_whatever.c        /* audio plugin */
  54.     client/audio_whatever.h        /* audio plugin's header */
  55.  
  56. ================================
  57.  Tags
  58. ================================
  59.  
  60. There are two kinds of sound tags:
  61.  - defined in the rulesets
  62.  - defined in the program code
  63.  
  64. While the former can be chosen freely the latter can't be changed.
  65.  
  66. The sound tags associated with improvements (wonders and normal
  67. buildings), unit movements and unit fights have to be set in the
  68. rulesets. Freeciv just hand these sound tags over to the client where
  69. they are translated into the filenames of the sound files via the
  70. soundspec file. Every soundspec should have generic sound tags for
  71. wonders ("w_generic"), normal buildings ("b_generic"), unit movements
  72. ("m_generic") and unit fights ("f_generic").
  73.  
  74. Sound tags associated with certain events are generated in the Freeciv
  75. code and can't be configured from outside. The soundspec file also has
  76. to have mapping for these tags. The complete list of such tags can be
  77. found in data/stdsounds.spec. The name of the tag is enum name (see
  78. common/events.h) in lowercase. So E_POLLUTION becomes the tag
  79. "e_pollution". There is no generic event tag and no alternate tags are
  80. used.
  81.  
  82. There is currently only one music: the intro music. This music will be
  83. played until the game starts. The tag for this music is "music_start".
  84.  
  85. ================================
  86.  TODO
  87. ================================
  88.  
  89. There are a few things that can be done to get better sound support in
  90. Freeciv still:
  91.   * add more plugins (gstreamer, arts, windows, etc)
  92.   * add a sound tag for each technology, as for buildings/units
  93.   * add support for playing .ogg files
  94.   * always add more event tags
  95.   * find or create better sound samples and make better spec-file
  96.  
  97. ================================
  98.  Misc
  99. ================================
  100.  
  101. Sound creators: Please name sound files intelligibly. Include a README
  102. where you present the licensing terms used (if public domain, say so)
  103. for the sound files.
  104.  
  105. Modpack makers: Please give secondary tags that refer to standard tags 
  106. so that those who have not downloaded the latest & greatest sound pack 
  107. can still enjoy the game.
  108.